Agreement Management Biz API

1.0.x
(0 reviews)

CR Market

POST /agreement
  • Mandatory fields are: agreementType, documentNumber,agreementAuthorization.date, characteristic.store, characteristic.lob, engagedParty.id
  • documentNumber should be unique for create agreement calls.
  • Default value of characteristic.lob=FIXED

  • agreementAuthorization.date in the request is in costa rica localtime eg: "2023-04-19T00:00:00-06:00". Siebel is validating "date" in agreementAuthorization.date. if you are passing future data, then siebel will throw error

  • Refer request/response examples CR-B2B and CR-B2C

  • documentNumber only accepts numbers and it must be less than 12 characters long

  • Response from siebel contains only agreement id, all other fields are captured from the request.

  • Possible values of fields are given below. This is not the Final listand it may be changed based on the business requirement.

agreementType: CONTRATO HOMOLOGADO, PYMES, CONDOMINAL, PREFERENCIA, CANJE, CONTRATO MASTER, CONTRATO UNIVERSAL, EMPRESARIAL, HOTELERO

Applicable values for B2C: CONTRATO UNIVERSAL & CONTRATO HOMOLOGADO

statementOfIntent: HOTEL ECONOMICO 1, HOTEL VALOR 2, HOTEL CALIDAD 3, HOTEL SUPERIOR 4, HOTEL EXCEPCIONAL 5, HOTEL LUJOSO 6, CON COMPETENCIA, CONDO HIJO, CONDO PRINCIPAL, CORTESIA

Characteristic Sub-Resource Table.
NameTypeM/ODescription
characteristic.name="hotelType"StringOHotel Type, applicable for B2B.Possible Values: AEROPUERTO, PENSION, APARTOTEL, EJECUTIVO, CASINO, CLUB, DE PASO, MONTAÑA, VACACIONAL. Example
{
"name":"hotelType",
"value":"APARTOTEL"
}
characteristic.name="hotelChain"StringOHotel Chain, applicable for B2B.Possible Values : AM RESORT, BARCELO HOTELS & RESORT, C.H.E GROUP PLC, ENJOY HOTELS, ESPLENDOR, INTERCONTINETAL HOTELS GROUP, SOL MELIA, STARWOOD HOTELS & RESORT WORLD, BEST WESTERN INTERNATIONAL, CARLSON REZINDOR HOTEL GROUP, CARLSON HOSPITALITY WORLDWIDE, CHOICE HOTELS INTERNACIONAL, FIESTA HOTEL GROUP, FOUR SEASONS HOTELS & RESORTS, GLOBAL HYATT CORP, ACOMETIDA INSTALADA, AEREA EXPUESTA, DUCTO CON PIOLA, DUCTO SIN PIOLA, HILTONS HOTELS CORP, HOSPITALITY INTERNATIONAL, MARRIOT INTERNACIONAL, NINGUNA, OCCIDENTALS HOTELS, RIU HOTELS, WYNDHAM WORLDWIDE. Example
{
"name":"hotelChain",
"value":"ENJOY HOTELS"
}
characteristic.name="store"StringMStore.Possible Values : SAN JOSE, PEREZ ZELEDON, SAN CARLOS, PALMARES, OROTINA, LIBERIA, LA CRUZ, TILARAN, LAS JUNTAS, LIMON. Example
{
"name":"store",
"value":"TILARAN"
}
characteristic.name="rooms"StringORooms, applicable for B2B. Example
{
"name":"rooms",
"value":"10"
}
characteristic.name="socialAreas"StringOSocial Areas, applicable for B2B. Example
{
"name":"socialAreas",
"value":"Y"
}
characteristic.name="socialAreasQty"StringOSocialAreas Qty, applicable for B2B. Example
{
"name":"socialAreasQty",
"value":"2"
}
characteristic.name="invoiceDollars"StringOBoolean to indicate Invoice in Dollars, applicable for B2B. Boolean Y or N. Example
{
"name":"invoiceDollars",
"value":"N"
}
GET/agreement/{id}

Refer CR-B2C example for B2C, New customer usecase

  • The contract consultation web service will only allow the query of 1customer at a time.
  • For possible values, refer the Characteristic table mentioned above
PATCH /agreement/{id}

Refer CR-B2C example for B2C, New customer usecase

  • The Consumer must respect the values of the lists of values configuredin the fields.
  • agreementType,agreementAuthorization.date and characteristic.store are Mandatory field
  • Default value of characteristic.value=FIXED, when characteristic.name=lob as per example and its mandatory
  • The customer modification web service will only allow the modificationof 1 client at a time.
  • The modification process will only modify the information of thefields that are not equal to empty, that is, if in the input messageonly the email value is different from empty, the process will onlychange the value of this field.
  • This process will not modify information of the Contacts and/orAddresses entity.
  • statementOfIntent, agreementAuthorization.date, characteristic.value (for updating store) can be updated.
  • Siebel is validating "date" in agreementAuthorization.date. if you are passing future data, then siebel will throw error
  • document number and agreement id should be matching with the created agreement in siebel, otherwise siebel will throw error.
  • For possible values, refer the Characteristic table mentioned above
  • Fields present in the response are mapped from request and no fields are present in the response from siebel.

Reviews